HAL DCMI APIs listing for migration

This section provides a full listing of the HAL1 APIs for migration. It includes the various constants, enumerations, structures, functions, and macros.

HAL DCMI constants

HAL1	series	HAL2	Refer to
DCMI_BSM_ALL	u5, h5, l4, f4, h7	HAL_DCMI_BYTE_CAPTURE_ALL	Refer to
DCMI_BSM_ALTERNATE_2	u5, h5, l4, f4, h7	HAL_DCMI_BYTE_CAPTURE_1BYTE_OUT_2_ODD / HAL_DCMI_BYTE_CAPTURE_1BYTE_OUT_2_EVEN	Refer to
DCMI_BSM_ALTERNATE_4	u5, h5, l4, f4, h7	HAL_DCMI_BYTE_CAPTURE_1BYTE_OUT_4_ODD / HAL_DCMI_BYTE_CAPTURE_1BYTE_OUT_4_EVEN	Refer to
DCMI_BSM_OTHER	u5, h5, l4, f4, h7	HAL_DCMI_BYTE_CAPTURE_2BYTE_OUT_4_ODD / HAL_DCMI_BYTE_CAPTURE_2BYTE_OUT_4_EVEN	Refer to
DCMI_CR_ALL_FRAME	u5, h5, l4, f4, h7	HAL_DCMI_FRAME_CAPTURE_ALL	Refer to
DCMI_CR_ALTERNATE_2_FRAME	u5, h5, l4, f4, h7	HAL_DCMI_FRAME_CAPTURE_1FRAME_OUT_2	Refer to
DCMI_CR_ALTERNATE_4_FRAME	u5, h5, l4, f4, h7	HAL_DCMI_FRAME_CAPTURE_1FRAME_OUT_4	Refer to
DCMI_EXTEND_DATA_10B	u5, h5, l4, f4, h7	HAL_DCMI_EXTENDED_DATA_10_BITS	Refer to
DCMI_EXTEND_DATA_12B	u5, h5, l4, f4, h7	HAL_DCMI_EXTENDED_DATA_12_BITS	Refer to
DCMI_EXTEND_DATA_14B	u5, h5, l4, f4, h7	HAL_DCMI_EXTENDED_DATA_14_BITS	Refer to
DCMI_EXTEND_DATA_8B	u5, h5, l4, f4, h7	HAL_DCMI_EXTENDED_DATA_8_BITS	Refer to
DCMI_FLAG_ERRMI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PARALLEL_SYNC_ERR	Refer to
DCMI_FLAG_ERRRI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PARALLEL_SYNC_ERR	Refer to
DCMI_FLAG_FNE	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_FNE	Refer to
DCMI_FLAG_FRAMEMI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_FRAME	Refer to
DCMI_FLAG_FRAMERI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_FRAME	Refer to
DCMI_FLAG_HSYNC	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_HSYNC	Refer to
DCMI_FLAG_LINEMI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_LINE	Refer to
DCMI_FLAG_LINERI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_LINE	Refer to
DCMI_FLAG_OVRMI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_OVR	Refer to
DCMI_FLAG_OVRRI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_OVR	Refer to
DCMI_FLAG_VSYNC	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_VSYNC / HAL_DCMI_FLAG_PIPE0_VSYNC_PIN	Refer to
DCMI_FLAG_VSYNCMI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_VSYNC	Refer to
DCMI_FLAG_VSYNCRI	u5, h5, l4, f4, h7	HAL_DCMI_FLAG_PIPE0_VSYNC	Refer to
DCMI_HSPOLARITY_HIGH	u5, h5, l4, f4, h7	HAL_DCMI_HSYNC_HIGH	Refer to
DCMI_HSPOLARITY_LOW	u5, h5, l4, f4, h7	HAL_DCMI_HSYNC_LOW	Refer to
DCMI_IT_ERR	u5, h5, l4, f4, h7	HAL_DCMI_IT_PARALLEL_SYNC_ERR	Refer to
DCMI_IT_FRAME	u5, h5, l4, f4, h7	HAL_DCMI_IT_PIPE0_FRAME	Refer to
DCMI_IT_LINE	u5, h5, l4, f4, h7	HAL_DCMI_IT_PIPE0_LINE	Refer to
DCMI_IT_OVR	u5, h5, l4, f4, h7	HAL_DCMI_IT_PIPE0_OVR	Refer to
DCMI_IT_VSYNC	u5, h5, l4, f4, h7	HAL_DCMI_IT_PIPE0_VSYNC	Refer to
DCMI_JPEG_DISABLE	u5, h5, l4, f4, h7	HAL_DCMI_FORMAT_UNCOMPRESSED	Refer to
DCMI_JPEG_ENABLE	u5, h5, l4, f4, h7	HAL_DCMI_FORMAT_JPEG	Refer to
DCMI_LSM_ALL	u5, h5, l4, f4, h7	HAL_DCMI_LINE_CAPTURE_ALL	Refer to
DCMI_LSM_ALTERNATE_2	u5, h5, l4, f4, h7	HAL_DCMI_LINE_CAPTURE_1LINE_OUT_2_ODD / HAL_DCMI_LINE_CAPTURE_1LINE_OUT_2_EVEN	Refer to
DCMI_MODE_CONTINUOUS	u5, h5, l4, f4, h7	HAL_DCMI_CAPTURE_CONTINUOUS	Refer to
DCMI_MODE_SNAPSHOT	u5, h5, l4, f4, h7	HAL_DCMI_CAPTURE_SNAPSHOT	Refer to
DCMI_OEBS_EVEN	u5, h5, l4, f4, h7	Integrated: use appropriate HAL_DCMI_BYTE_CAPTURE_*_EVEN enumerator	Refer to
DCMI_OEBS_ODD	u5, h5, l4, f4, h7	Integrated: use appropriate HAL_DCMI_BYTE_CAPTURE_*_ODD enumerator	Refer to
DCMI_OELS_EVEN	u5, h5, l4, f4, h7	Integrated: HAL_DCMI_LINE_CAPTURE_1LINE_OUT_2_EVEN	Refer to
DCMI_OELS_ODD	u5, h5, l4, f4, h7	Integrated: HAL_DCMI_LINE_CAPTURE_1LINE_OUT_2_ODD	Refer to
DCMI_PCKPOLARITY_FALLING	u5, h5, l4, f4, h7	HAL_DCMI_PIXEL_CLOCK_FALLING	Refer to
DCMI_PCKPOLARITY_RISING	u5, h5, l4, f4, h7	HAL_DCMI_PIXEL_CLOCK_RISING	Refer to
DCMI_POSITION_CWSIZE_VLINE	f4	Not implemented yet in HAL2.	Refer to
DCMI_POSITION_CWSTRT_VST	f4	Not implemented yet in HAL2.	Refer to
DCMI_POSITION_ESCR_FEC	f4	Not implemented yet in HAL2.	Refer to
DCMI_POSITION_ESCR_LEC	f4	Not implemented yet in HAL2.	Refer to
DCMI_POSITION_ESCR_LSC	f4	Not implemented yet in HAL2.	Refer to
DCMI_SYNCHRO_EMBEDDED	u5, h5, l4, f4, h7	HAL_DCMI_SYNC_EMBEDDED	Refer to
DCMI_SYNCHRO_HARDWARE	u5, h5, l4, f4, h7	HAL_DCMI_SYNC_HARDWARE	Refer to
DCMI_VSPOLARITY_HIGH	u5, h5, l4, f4, h7	HAL_DCMI_VSYNC_HIGH	Refer to
DCMI_VSPOLARITY_LOW	u5, h5, l4, f4, h7	HAL_DCMI_VSYNC_LOW	Refer to
DCMI_WINDOW_COORDINATE	u5, h5, f4, h7	Removed / New Usage changes	Refer to
DCMI_WINDOW_HEIGHT	u5, h5, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_ERROR_DMA	u5, h5, l4, f4, h7	HAL_DCMI_ERROR_PIPE0_DMA	Refer to
HAL_DCMI_ERROR_INVALID_CALLBACK	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_ERROR_NONE	u5, h5, l4, f4, h7	HAL_DCMI_ERROR_NONE	Refer to
HAL_DCMI_ERROR_OVR	u5, h5, l4, f4, h7	HAL_DCMI_ERROR_PIPE0_OVR	Refer to
HAL_DCMI_ERROR_SYNC	u5, h5, l4, f4, h7	HAL_DCMI_ERROR_PARALLEL_SYNC	Refer to
HAL_DCMI_ERROR_TIMEOUT	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to

---

HAL DCMI enumerations

HAL1	series	HAL2	Refer to
HAL_DCMI_CallbackIDTypeDef	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_ERROR_CB_ID	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_FRAME_EVENT_CB_ID	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_LINE_EVENT_CB_ID	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_MSPDEINIT_CB_ID	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_MSPINIT_CB_ID	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_STATE_BUSY	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_STATE_ERROR	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_STATE_READY	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_STATE_RESET	u5, h5, l4, f4, h7	HAL_DCMI_STATE_RESET	Refer to
HAL_DCMI_STATE_SUSPENDED	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_STATE_TIMEOUT	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_StateTypeDef	u5, h5, l4, f4, h7	hal_dcmi_state_t	Refer to
HAL_DCMI_VSYNC_EVENT_CB_ID	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to

---

HAL DCMI macros

HAL1	series	HAL2	Refer to
__HAL_DCMI_CLEAR_FLAG	u5, h5, l4, f4, h7	HAL_DCMI_ClearFlag	Refer to
__HAL_DCMI_DISABLE	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
__HAL_DCMI_DISABLE_IT	u5, h5, l4, f4, h7	HAL_DCMI_DisableIT	Refer to
__HAL_DCMI_ENABLE	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
__HAL_DCMI_ENABLE_IT	u5, h5, l4, f4, h7	HAL_DCMI_EnableIT	Refer to
__HAL_DCMI_GET_FLAG	u5, h5, l4, f4, h7	HAL_DCMI_IsActiveFlag	Refer to
__HAL_DCMI_GET_IT_SOURCE	u5, h5, l4, f4, h7	HAL_DCMI_IsEnabledIT	Refer to
__HAL_DCMI_RESET_HANDLE_STATE	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to

---

HAL DCMI structures

HAL1	series	HAL2	Refer to
DCMI_CodesInitTypeDef	u5, h5, l4, f4, h7	hal_dcmi_parallel_emb_sync_config_t	Refer to
DCMI_HandleTypeDef	u5, h5, l4, f4, h7	hal_dcmi_handle_t	Refer to
DCMI_InitTypeDef	u5, h5, l4, f4, h7	hal_dcmi_pipe_config_t	Refer to
DCMI_SyncUnmaskTypeDef	u5, h5, l4, f4, h7	hal_dcmi_parallel_config_t	Refer to
pDCMI_CallbackTypeDef	u5, h5, l4, f4, h7	hal_dcmi_pipe_cb_t / hal_dcmi_cb_t	Refer to

---

HAL DCMI functions

HAL1	series	HAL2	Refer to
HAL_DCMI_ConfigCrop	u5, h5, l4, f4, h7	HAL_DCMI_SetConfigPipeCrop	Refer to
HAL_DCMI_ConfigSyncUnmask	u5, h5, l4, f4, h7	HAL_DCMI_PARALLEL_SetEmbSyncCode / HAL_DCMI_PARALLEL_SetEmbSyncMask	Refer to
HAL_DCMI_DeInit	u5, h5, l4, f4, h7	HAL_DCMI_DeInit	Refer to
HAL_DCMI_DisableCrop	u5, h5, l4, f4, h7	HAL_DCMI_DisablePipeCrop	Refer to
HAL_DCMI_EnableCrop	u5, h5, l4, f4, h7	HAL_DCMI_EnablePipeCrop	Refer to
HAL_DCMI_ErrorCallback	u5, h5, l4, f4, h7	HAL_DCMI_ErrorCallback / HAL_DCMI_PipeErrorCallback	Refer to
HAL_DCMI_FrameEventCallback	u5, h5, l4, f4, h7	HAL_DCMI_PipeFrameEventCallback	Refer to
HAL_DCMI_GetError	u5, h5, l4, f4, h7	HAL_DCMI_GetLastErrorCodes	Refer to
HAL_DCMI_GetState	u5, h5, l4, f4, h7	HAL_DCMI_GetState	Refer to
HAL_DCMI_IRQHandler	u5, h5, l4, f4, h7	HAL_DCMI_IRQHandler	Refer to
HAL_DCMI_Init	u5, h5, l4, f4, h7	HAL_DCMI_Init	Refer to
HAL_DCMI_LineEventCallback	u5, h5, l4, f4, h7	HAL_DCMI_PipeLineEventCallback	Refer to
HAL_DCMI_MspDeInit	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_MspInit	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_RegisterCallback	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_Resume	u5, h5, l4, f4, h7	HAL_DCMI_ResumePipe	Refer to
HAL_DCMI_Start_DMA	u5, h5, l4, f4, h7	HAL_DCMI_StartPipe_DMA	Refer to
HAL_DCMI_Stop	u5, h5, l4, f4, h7	HAL_DCMI_StopPipe_DMA	Refer to
HAL_DCMI_Suspend	u5, h5, l4, f4, h7	HAL_DCMI_SuspendPipe	Refer to
HAL_DCMI_UnRegisterCallback	u5, h5, l4, f4, h7	Removed / New Usage changes	Refer to
HAL_DCMI_VsyncEventCallback	u5, h5, l4, f4, h7	HAL_DCMI_PipeVsyncEventCallback	Refer to
HAL_DCMI_HsyncCallback	f4	Not implemented yet in HAL2.	Refer to
HAL_DCMI_VsyncCallback	f4	Not implemented yet in HAL2.	Refer to

---

HAL DCMI legacy aliases (HAL1 to HAL1)

HAL1 legacy API alias	HAL1 API
DCMI_FLAG_OVFMI	DCMI_FLAG_OVRMI
DCMI_FLAG_OVFRI	DCMI_FLAG_OVRRI
DCMI_IT_OVF	DCMI_IT_OVR
HAL_DCMI_ConfigCROP	HAL_DCMI_ConfigCrop
HAL_DCMI_DisableCROP	HAL_DCMI_DisableCrop
HAL_DCMI_ERROR_OVF	HAL_DCMI_ERROR_OVR
HAL_DCMI_EnableCROP	HAL_DCMI_EnableCrop